Leadtools.ImageProcessing.Effects Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
SpatialFilterCommand Constructor(Int32,Int32,Int32[])
See Also  Example
Leadtools.ImageProcessing.Effects Namespace > SpatialFilterCommand Class > SpatialFilterCommand Constructor : SpatialFilterCommand Constructor(Int32,Int32,Int32[])



divisor
Number used to divide the sum of weighted values.
bias
Number added to the weighted average.
matrix
The array of weighting factors. The factors apply to pixels in the neighborhood read left to right and top to bottom, as shown below
Initializes a new SpatialFilterCommand class object with explicit parameters.

Syntax

Visual Basic (Declaration) 
Public Function New( _
   ByVal divisor As Integer, _
   ByVal bias As Integer, _
   ByVal matrix() As Integer _
)
Visual Basic (Usage)Copy Code
Dim divisor As Integer
Dim bias As Integer
Dim matrix() As Integer
 
Dim instance As SpatialFilterCommand(divisor, bias, matrix)
C# 
public SpatialFilterCommand( 
   int divisor,
   int bias,
   int[] matrix
)
C++/CLI 
public:
SpatialFilterCommand( 
   int divisor,
   int bias,
   array<int>^ matrix
)

Parameters

divisor
Number used to divide the sum of weighted values.
bias
Number added to the weighted average.
matrix
The array of weighting factors. The factors apply to pixels in the neighborhood read left to right and top to bottom, as shown below

Example

Run the SpatialFilterCommand on an image.

Visual BasicCopy Code
Public Sub SpatialFilterConstructorExample_S2()
   RasterCodecs.Startup()
   Dim codecs As New RasterCodecs()
   codecs.ThrowExceptionsOnInvalidImages = True

   Dim leadImage As RasterImage = codecs.Load(LeadtoolsExamples.Common.ImagesPath.Path + "Master.jpg")

   ' Prepare the command
   Dim command1 As SpatialFilterCommand = New SpatialFilterCommand(SpatialFilterCommandPredefined.EmbossSouth)
   Dim data() As Integer = command1.Matrix
   Dim command As SpatialFilterCommand = New SpatialFilterCommand(command1.Divisor, command1.Bias, data)
   'Apply the filter.
   command.Run(leadImage)
   codecs.Save(leadImage, LeadtoolsExamples.Common.ImagesPath.Path + "Result.jpg", RasterImageFormat.Jpeg, 24)

   RasterCodecs.Shutdown()
End Sub
C#Copy Code
public void SpatialFilterConstructorExample_S2() 

   // Load an image 
   RasterCodecs.Startup(); 
   RasterCodecs codecs = new RasterCodecs(); 
   codecs.ThrowExceptionsOnInvalidImages = true; 
 
   RasterImage image = codecs.Load(LeadtoolsExamples.Common.ImagesPath.Path + "Master.jpg"); 
 
   // Prepare the command 
   SpatialFilterCommand command1 = new SpatialFilterCommand(SpatialFilterCommandPredefined.EmbossSouth); 
   int [] data = command1.Matrix; 
   SpatialFilterCommand command = new SpatialFilterCommand(command1.Divisor , command1.Bias , data); 
   //Apply the filter. 
   command.Run(image); 
 
   RasterCodecs.Shutdown(); 
}

Requirements

Target Platforms: Microsoft .NET Framework 2.0, Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also